-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
1286 document config parameters in plugins #1297
base: develop
Are you sure you want to change the base?
Conversation
jlahovnik
commented
Aug 14, 2024
- docstrings for the configuration parameters have been added for all plugins
- in case documentation was already existing it was standardized and updated
- NOTE: for currently unused plugins (such as CSWSearch or S3RestDownload) the documentation might be incomplete due to missing examples; it should be updated when they are used again
Code Coverage (Ubuntu)
Diff against develop
Results for commit: db46808 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Code Coverage (Windows)
Diff against develop
Results for commit: db46808 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
4215f14
to
d6fc761
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please edit docstrings layout, following HttpDownload
, QueryStringSearch
and ODataV4Search
models:
- describe config parameters inside
config
parameter description - link parameters to their
PluginConfig
class variable - if
PluginConfig
class variable (attribute ou TypedDict) is missing, add it